Skip to main content

PublicApi

All URIs are relative to **

MethodHTTP requestDescription
publicByCidCidGetGET /public/by-cid/{cid}Get Content by Cid
publicInfoGetGET /public/infoGet public node info
publicMetricsDealsOnChainGetGET /public/metrics/deals-on-chainGet deal metrics
publicMinersDealsMinerGetGET /public/miners/deals/{miner}Get all miners deals
publicMinersFailuresMinerGetGET /public/miners/failures/{miner}Get all miners
publicMinersGetGET /public/minersGet all miners
publicMinersStatsMinerGetGET /public/miners/stats/{miner}Get miner stats
publicNetAddrsGetGET /public/net/addrsNet Addrs
publicNetPeersGetGET /public/net/peersNet Peers
publicStatsGetGET /public/statsPublic stats

publicByCidCidGet

Get Content by Cid

This endpoint returns the content associated with a CID

Example

 publicByCidCidGet cid=value

Parameters

NameTypeDescriptionNotes
cidstringCid

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicInfoGet

Get public node info

This endpoint returns information about the node

Example

 publicInfoGet

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicMetricsDealsOnChainGet

Get deal metrics

This endpoint is used to get deal metrics

Example

 publicMetricsDealsOnChainGet

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicMinersDealsMinerGet

Get all miners deals

This endpoint returns all miners deals

Example

 publicMinersDealsMinerGet miner=value  ignore-failed=value

Parameters

NameTypeDescriptionNotes
minerstringFilter by miner
ignoreFailedstringIgnore Failed[optional]

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicMinersFailuresMinerGet

Get all miners

This endpoint returns all miners

Example

 publicMinersFailuresMinerGet miner=value

Parameters

NameTypeDescriptionNotes
minerstringFilter by miner

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicMinersGet

Get all miners

This endpoint returns all miners

Example

 publicMinersGet

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicMinersStatsMinerGet

Get miner stats

This endpoint returns miner stats

Example

 publicMinersStatsMinerGet miner=value

Parameters

NameTypeDescriptionNotes
minerstringFilter by miner

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicNetAddrsGet

Net Addrs

This endpoint is used to get net addrs

Example

 publicNetAddrsGet

Parameters

This endpoint does not need any parameter.

Return type

array[string]

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicNetPeersGet

Net Peers

This endpoint is used to get net peers

Example

 publicNetPeersGet

Parameters

This endpoint does not need any parameter.

Return type

array[string]

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicStatsGet

Public stats

This endpoint is used to get public stats.

Example

 publicStatsGet

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]